-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
New Guidance on Creating Documentation Organization Hierarchy #30
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @riverma. On review, here are my comments:
- Is this duplicating the Use Case diagram? Is that necessary? My thoughts were that maybe this section would contain a flow chart or UML to discuss the creation process rather than reviewing implementation.
- What parts are auto-generated, and is it necessary here? The reason I ask that is after we talked last I understood the architecture would be sort of high-level planning or flow oriented.
- I may be thinking of things from the perspective of application design, so my comments could be out of context or don't translate well to the documentation problem space.
Great questions @jpl-jengelke - let me see if I can answer them.
The use of markmap.js here is purely out of need, and not to be mistaken for creating another use case diagram. I was looking for a way to visualize a hierarchy, and realized markmap would support that well. That being said, you've got me thinking whether people may be confused by the style of this diagram. I think Mermaid supports hierarchy graphs so let me see if that renders well for this kind of graph.
Auto-generation would be a good idea, but I don't think for this section. You're right that the architecture section is more a referential planning artifact. I'm thinking that we could have starter kits that auto-generate this reference architecture (hierarchy) for various documentation host providers like: Confluence, GitBook, ReadTheDocs, etc.
These are good questions - no problem! |
This file showcases the current proposed documentation hierarchy: https://github.com/NASA-AMMOS/slim/pull/30/files#diff-418170666bb25e2f47cc5960c5df52f585d3233c186bb678f48d1862db3d00cc Please share your comments / review this - thanks! |
Closing in place of #149 |
Purpose
Proposed Changes
Issues
Testing